org.springframework.scheduling.backportconcurrent

Class ThreadPoolTaskExecutor

java.lang.Object

org.springframework.util.CustomizableThreadCreator

org.springframework.scheduling.backportconcurrent.CustomizableThreadFactory

org.springframework.scheduling.backportconcurrent.ThreadPoolTaskExecutor

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.Executor, Aware, BeanNameAware, DisposableBean, InitializingBean, AsyncTaskExecutor, TaskExecutor, SchedulingTaskExecutor

public class ThreadPoolTaskExecutor
extends CustomizableThreadFactory
implements SchedulingTaskExecutor, BeanNameAware, InitializingBean, DisposableBean

JavaBean that allows for configuring a JSR-166 backport edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" properties), exposing it as a Spring TaskExecutor. This is an alternative to configuring a ThreadPoolExecutor instance directly using constructor injection, with a separate ConcurrentTaskExecutor adapter wrapping it.

For any custom needs, in particular for defining a edu.emory.mathcs.backport.java.util.concurrent.ScheduledThreadPoolExecutor, it is recommended to use a straight definition of the Executor instance or a factory method definition that points to the JSR-166 backport edu.emory.mathcs.backport.java.util.concurrent.Executors class. To expose such a raw Executor as a Spring TaskExecutor, simply wrap it with a ConcurrentTaskExecutor adapter.

NOTE: This class implements Spring's TaskExecutor interface (and hence implicitly the standard Java 5 Executor interface) as well as the JSR-166 edu.emory.mathcs.backport.java.util.concurrent.Executor interface, with the former being the primary interface, the other just serving as secondary convenience. For this reason, the exception handling follows the TaskExecutor contract rather than the backport Executor contract, in particular regarding the TaskRejectedException.

Since:

2.0.3

Author:

Juergen Hoeller

See Also:

TaskExecutor, edu.emory.mathcs.backport.java.util.concurrent.Executor, edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor, edu.emory.mathcs.backport.java.util.concurrent.ScheduledThreadPoolExecutor, edu.emory.mathcs.backport.java.util.concurrent.Executors, ConcurrentTaskExecutor, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowCoreThreadTimeOut
private java.lang.String	beanName
private int	corePoolSize
private int	keepAliveSeconds
protected Log	logger
private int	maxPoolSize
private java.lang.Object	poolSizeMonitor
private int	queueCapacity
private RejectedExecutionHandler	rejectedExecutionHandler
private ThreadFactory	threadFactory
private boolean	threadNamePrefixSet
private ThreadPoolExecutor	threadPoolExecutor
private boolean	waitForTasksToCompleteOnShutdown

Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor

TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE

Constructor Summary

Constructors

Constructor and Description
ThreadPoolTaskExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Calls initialize() after the container applied all property values.
protected BlockingQueue	createQueue(int queueCapacity) Create the BlockingQueue to use for the ThreadPoolExecutor.
void	destroy() Calls shutdown when the BeanFactory destroys the task executor instance.
void	execute(java.lang.Runnable task) Implementation of both the JSR-166 backport Executor interface and the Spring TaskExecutor interface, delegating to the ThreadPoolExecutor instance.
void	execute(java.lang.Runnable task, long startTimeout) Execute the given task.
int	getActiveCount() Return the number of currently active threads.
int	getCorePoolSize() Return the ThreadPoolExecutor's core pool size.
int	getKeepAliveSeconds() Return the ThreadPoolExecutor's keep-alive seconds.
int	getMaxPoolSize() Return the ThreadPoolExecutor's maximum pool size.
int	getPoolSize() Return the current pool size.
ThreadPoolExecutor	getThreadPoolExecutor() Return the underlying ThreadPoolExecutor for native access.
void	initialize() Creates the BlockingQueue and the ThreadPoolExecutor.
boolean	prefersShortLivedTasks() This task executor prefers short-lived work units.
void	setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) Specify whether to allow core threads to time out.
void	setBeanName(java.lang.String name) Set the name of the bean in the bean factory that created this bean.
void	setCorePoolSize(int corePoolSize) Set the ThreadPoolExecutor's core pool size.
void	setKeepAliveSeconds(int keepAliveSeconds) Set the ThreadPoolExecutor's keep-alive seconds.
void	setMaxPoolSize(int maxPoolSize) Set the ThreadPoolExecutor's maximum pool size.
void	setQueueCapacity(int queueCapacity) Set the capacity for the ThreadPoolExecutor's BlockingQueue.
void	setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler) Set the RejectedExecutionHandler to use for the ThreadPoolExecutor.
void	setThreadFactory(ThreadFactory threadFactory) Set the ThreadFactory to use for the ThreadPoolExecutor's thread pool.
void	setThreadNamePrefix(java.lang.String threadNamePrefix) Specify the prefix to use for the names of newly created threads.
void	setWaitForTasksToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown) Set whether to wait for scheduled tasks to complete on shutdown.
void	shutdown() Perform a shutdown on the ThreadPoolExecutor.
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> task) Submit a Callable task for execution, receiving a Future representing that task.
java.util.concurrent.Future<?>	submit(java.lang.Runnable task) Submit a Runnable task for execution, receiving a Future representing that task.

Methods inherited from class org.springframework.scheduling.backportconcurrent.CustomizableThreadFactory

newThread

Methods inherited from class org.springframework.util.CustomizableThreadCreator

createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final Log logger

poolSizeMonitor

private final java.lang.Object poolSizeMonitor

corePoolSize

private int corePoolSize

maxPoolSize

private int maxPoolSize

keepAliveSeconds

private int keepAliveSeconds

allowCoreThreadTimeOut

private boolean allowCoreThreadTimeOut

queueCapacity

private int queueCapacity

threadFactory

private ThreadFactory threadFactory

rejectedExecutionHandler

private RejectedExecutionHandler rejectedExecutionHandler

waitForTasksToCompleteOnShutdown

private boolean waitForTasksToCompleteOnShutdown

threadNamePrefixSet

private boolean threadNamePrefixSet

beanName

private java.lang.String beanName

threadPoolExecutor

private ThreadPoolExecutor threadPoolExecutor

Constructor Detail

ThreadPoolTaskExecutor

public ThreadPoolTaskExecutor()

Method Detail

setCorePoolSize

public void setCorePoolSize(int corePoolSize)

Set the ThreadPoolExecutor's core pool size. Default is 1.

This setting can be modified at runtime, for example through JMX.

getCorePoolSize

public int getCorePoolSize()

Return the ThreadPoolExecutor's core pool size.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Set the ThreadPoolExecutor's maximum pool size. Default is Integer.MAX_VALUE.

This setting can be modified at runtime, for example through JMX.

getMaxPoolSize

public int getMaxPoolSize()

Return the ThreadPoolExecutor's maximum pool size.

setKeepAliveSeconds

public void setKeepAliveSeconds(int keepAliveSeconds)

Set the ThreadPoolExecutor's keep-alive seconds. Default is 60.

This setting can be modified at runtime, for example through JMX.

getKeepAliveSeconds

public int getKeepAliveSeconds()

Return the ThreadPoolExecutor's keep-alive seconds.

setAllowCoreThreadTimeOut

public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)

Specify whether to allow core threads to time out. This enables dynamic growing and shrinking even in combination with a non-zero queue (since the max pool size will only grow once the queue is full).

Default is "false". Note that this feature is only available on backport-concurrent 3.0 or above (based on the code in Java 6).

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#allowCoreThreadTimeOut(boolean)

setQueueCapacity

public void setQueueCapacity(int queueCapacity)

Set the capacity for the ThreadPoolExecutor's BlockingQueue. Default is Integer.MAX_VALUE.

Any positive value will lead to a LinkedBlockingQueue instance; any other value will lead to a SynchronousQueue instance.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.LinkedBlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.SynchronousQueue

setThreadFactory

public void setThreadFactory(ThreadFactory threadFactory)

Set the ThreadFactory to use for the ThreadPoolExecutor's thread pool.

Default is this executor itself (i.e. the factory that this executor inherits from). See CustomizableThreadCreator's javadoc for available bean properties.

See Also:

CustomizableThreadCreator.setThreadPriority(int), CustomizableThreadCreator.setDaemon(boolean)

setRejectedExecutionHandler

public void setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

Set the RejectedExecutionHandler to use for the ThreadPoolExecutor. Default is the ThreadPoolExecutor's default abort policy.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor.AbortPolicy

setWaitForTasksToCompleteOnShutdown

public void setWaitForTasksToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown)

Set whether to wait for scheduled tasks to complete on shutdown.

Default is "false". Switch this to "true" if you prefer fully completed tasks at the expense of a longer shutdown phase.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#shutdown(), edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#shutdownNow()

setThreadNamePrefix

public void setThreadNamePrefix(java.lang.String threadNamePrefix)

Description copied from class: CustomizableThreadCreator

Specify the prefix to use for the names of newly created threads. Default is "SimpleAsyncTaskExecutor-".

Overrides:

setThreadNamePrefix in class CustomizableThreadCreator

setBeanName

public void setBeanName(java.lang.String name)

Description copied from interface: BeanNameAware

Set the name of the bean in the bean factory that created this bean.

Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:

setBeanName in interface BeanNameAware

Parameters:

name - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.

afterPropertiesSet

public void afterPropertiesSet()

Calls initialize() after the container applied all property values.

Specified by:

afterPropertiesSet in interface InitializingBean

See Also:

initialize()

initialize

public void initialize()

Creates the BlockingQueue and the ThreadPoolExecutor.

See Also:

createQueue(int)

createQueue

protected BlockingQueue createQueue(int queueCapacity)

Create the BlockingQueue to use for the ThreadPoolExecutor.

A LinkedBlockingQueue instance will be created for a positive capacity value; a SynchronousQueue else.

Parameters:

queueCapacity - the specified queue capacity

Returns:

the BlockingQueue instance

See Also:

edu.emory.mathcs.backport.java.util.concurrent.LinkedBlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.SynchronousQueue

getThreadPoolExecutor

public ThreadPoolExecutor getThreadPoolExecutor()
                                         throws java.lang.IllegalStateException

Return the underlying ThreadPoolExecutor for native access.

Returns:

the underlying ThreadPoolExecutor (never null)

Throws:

java.lang.IllegalStateException - if the ThreadPoolTaskExecutor hasn't been initialized yet

execute

public void execute(java.lang.Runnable task)

Implementation of both the JSR-166 backport Executor interface and the Spring TaskExecutor interface, delegating to the ThreadPoolExecutor instance.

Specified by:

execute in interface java.util.concurrent.Executor

Specified by:

execute in interface TaskExecutor

Parameters:

task - the Runnable to execute (never null)

See Also:

edu.emory.mathcs.backport.java.util.concurrent.Executor#execute(Runnable), TaskExecutor.execute(Runnable)

execute

public void execute(java.lang.Runnable task,
           long startTimeout)

Description copied from interface: AsyncTaskExecutor

Execute the given task.

Specified by:

execute in interface AsyncTaskExecutor

Parameters:

task - the Runnable to execute (never null)

startTimeout - the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are AsyncTaskExecutor.TIMEOUT_IMMEDIATE or AsyncTaskExecutor.TIMEOUT_INDEFINITE (the default as used by TaskExecutor.execute(Runnable)).

submit

public java.util.concurrent.Future<?> submit(java.lang.Runnable task)

Description copied from interface: AsyncTaskExecutor

Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a null result upon completion.

Specified by:

submit in interface AsyncTaskExecutor

Parameters:

task - the Runnable to execute (never null)

Returns:

a Future representing pending completion of the task

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)

Description copied from interface: AsyncTaskExecutor

Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.

Specified by:

submit in interface AsyncTaskExecutor

Parameters:

task - the Callable to execute (never null)

Returns:

a Future representing pending completion of the task

prefersShortLivedTasks

public boolean prefersShortLivedTasks()

This task executor prefers short-lived work units.

Specified by:

prefersShortLivedTasks in interface SchedulingTaskExecutor

Returns:

true if this TaskExecutor prefers short-lived tasks

getPoolSize

public int getPoolSize()

Return the current pool size.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#getPoolSize()

getActiveCount

public int getActiveCount()

Return the number of currently active threads.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#getActiveCount()

destroy

public void destroy()

Calls shutdown when the BeanFactory destroys the task executor instance.

Specified by:

destroy in interface DisposableBean

See Also:

shutdown()

shutdown

public void shutdown()

Perform a shutdown on the ThreadPoolExecutor.

See Also:

edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor#shutdown()